home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Source Code / Libraries / DCLAP 6d / dclap6d / network / entrez / client / netentr.asn next >
Text File  |  1996-07-05  |  11KB  |  322 lines
  1. --$Revision: 4.0 $
  2. --*********************************************************************
  3. --
  4. --  entrez.asn
  5. --   Jim Ostell, 1993
  6. --              revised from epstein/ostell 1992
  7. --
  8. --     messages for entrez functions
  9. --
  10. --*********************************************************************
  11.  
  12. NCBI-Entrez DEFINITIONS ::=
  13. BEGIN
  14.  
  15. IMPORTS Seq-entry FROM NCBI-SeqSet
  16.         Seq-id FROM NCBI-SeqLoc
  17.         Medline-entry FROM NCBI-MedLine
  18.         Link-set FROM NCBI-Access
  19.         Biostruc FROM MMDB
  20.     Bioseq FROM NCBI-Sequence
  21.         Cdrom-inf,Docsum FROM NCBI-CdRom;
  22.  
  23.         --**********************************
  24.         -- requests
  25.         --
  26.  
  27. Entrez-request ::= CHOICE {
  28.     init SEQUENCE {                -- EntrezInit
  29.         version VisibleString OPTIONAL
  30.     } ,
  31.     maxlinks NULL ,                -- EntGetMaxLinks
  32.     eval Entrez-termget ,          -- EntTLEval
  33.     docsum Entrez-docget ,         -- DocSum
  34.     linkuidlist Link-setget ,      -- LinkUidList
  35.     uidlinks Link-setget ,         -- UidLinks
  36.     byterm Entrez-term-by-term ,   -- TermListByTerm
  37.     bypage Entrez-term-by-page ,   -- TermListByPage
  38.     findterm Term-lookup ,         -- EntrezFindTerm
  39.     fini NULL ,                    -- EntrezFini
  40.     createnamed Entrez-named-list ,
  41.     getmle Entrez-docget ,          -- get MedlineEntry
  42.     getseq Entrez-seqget ,         -- get SeqEntry
  43.     evalX Entrez-termget ,         -- EntTLEvalX
  44.     createnamedX Entrez-named-listX ,
  45.     seqidforgi INTEGER ,           -- EntrezSeqIdForGI
  46.     findseqid Seq-id ,             -- EntrezFindSeqId
  47.     canneighbortext NULL ,         -- EntrezCanNeighborText
  48.     expanded-medline NULL ,
  49.     get-hierarchy Term-lookup ,
  50.     neighbortext Entrez-neighbor-text , -- EntrezNeighborText
  51.     eval-count Entrez-termget ,         -- EntTLEvalCount
  52.     initX SEQUENCE {                -- new EntrezInit
  53.         version VisibleString OPTIONAL
  54.     } ,
  55.     getbiostr Entrez-docget ,       -- EntrezBiostrucGet (obselete)
  56.     getbiostrX SEQUENCE {           -- EntrezBiostrucGet
  57.         complexity INTEGER ,
  58.         get Entrez-docget } ,
  59.     extrainfo INTEGER ,             -- obseletes maxlinks, canneighbortext, and expanded-medline
  60.     blast Entrez-blastreq ,         -- BLAST request
  61.     docsumX Entrez-docget ,         -- DocSum
  62.     getgenome Entrez-docget }          -- get Genome-based Seq-entry
  63.  
  64. Entrez-blastreq ::= SEQUENCE {
  65.     bsp Bioseq ,                   -- the sequence to be BLASTed
  66.     bsp-database Entrez-class ,
  67.     program VisibleString OPTIONAL ,
  68.     database VisibleString OPTIONAL ,
  69.     options VisibleString OPTIONAL ,
  70.     showprogress BOOLEAN OPTIONAL }
  71.  
  72. Entrez-docget ::= SEQUENCE {
  73.     class Entrez-class ,
  74.     mark-missing BOOLEAN OPTIONAL ,
  75.     ids Entrez-ids ,
  76.     defer-count INTEGER OPTIONAL }
  77.  
  78. Entrez-seqget ::= SEQUENCE {       -- SeqEntryGet
  79.     retype ENUMERATED {
  80.         entry (0) ,             -- the "natural" entry for this (nuc-prot)
  81.         bioseq (1) ,            -- only the bioseq identified
  82.         bioseq-set (2) ,        -- any seg-set it may be part of
  83.         nuc-prot (3) ,            -- any nuc-prot it may be part of
  84.         pub-set (4) } DEFAULT entry ,
  85.     mark-missing BOOLEAN OPTIONAL ,
  86.     ids Entrez-ids }
  87.  
  88. Entrez-termget ::= SEQUENCE {        -- terms query
  89.     max INTEGER OPTIONAL ,        -- maximum ids to return
  90.     cls Entrez-class ,            -- class of data to query
  91.     terms Entrez-term-list }
  92.  
  93. Entrez-class ::= ENUMERATED {     -- class of document to query
  94.     medline (0) ,
  95.     aa (1) ,
  96.     na (2) ,
  97.     st (3) ,
  98.     genome (4) }
  99.  
  100. Entrez-field ::= INTEGER {              -- type of field
  101.     word (0) ,        -- words
  102.     mesh (1) ,        -- meSH terms
  103.     keyword (2) ,     -- keyword
  104.     author (3) ,      -- author names
  105.     journal (4) ,     -- journal title
  106.     org (5) ,         -- organism name
  107.     accn (6),         -- accession number
  108.     gene (7) ,        -- gene symbol
  109.     prot (8) ,        -- protein name
  110.     ecno (9) ,        -- E.C. number
  111.     hierarchy (10) ,  -- organism and MeSH hierarchies
  112.     pubdate (11) ,    -- publication date
  113.     fkey (12) ,       -- feature key
  114.     prop (13) ,       -- properties
  115.     subs (14) ,       -- substance
  116.     mloc (15) }       -- map location
  117.  
  118. Entrez-operator ::= ENUMERATED {
  119.     lparen (1) ,
  120.     rparen (2) ,
  121.     andsymbl (3) ,
  122.     orsymbl (4) ,
  123.     butnotsymbl (5) }
  124.  
  125. Special-operand ::= SEQUENCE {
  126.     term     VisibleString ,
  127.     fld      Entrez-field ,
  128.     type     Entrez-class }
  129.  
  130. Total-operand ::= SEQUENCE {
  131.     term     VisibleString ,
  132.     fld      Entrez-field ,
  133.     type     Entrez-class }
  134.  
  135. Entrez-term-list ::= SEQUENCE OF CHOICE {
  136.     operator      Entrez-operator ,
  137.     sp-operand    Special-operand ,
  138.     tot-operand   Total-operand   }
  139.  
  140. Link-setget ::= SEQUENCE {
  141.     max INTEGER OPTIONAL ,        -- maximum ids to return
  142.     link-to-cls Entrez-class ,    -- class of data to return
  143.     query-cls Entrez-class ,      -- class of query
  144.     mark-missing BOOLEAN DEFAULT FALSE , -- need to know which IDs didn't match
  145.     query-size INTEGER ,          -- size of query
  146.     query SEQUENCE OF INTEGER }   -- ids of query
  147.  
  148.  
  149. Entrez-neighbor-text ::= SEQUENCE {
  150.     fld Entrez-field ,
  151.     percent-terms-to-use INTEGER ,
  152.     max-neighbors INTEGER ,
  153.     min-score INTEGER ,
  154.     normal-text VisibleString ,
  155.     special-text VisibleString }
  156.  
  157.         --*********************************
  158.         -- replies (back)
  159.         --
  160.  
  161. Entrez-back ::= CHOICE {
  162.     error INTEGER ,                -- Generic errors
  163.     init SEQUENCE {                -- EntrezInit
  164.         e-info Cdrom-inf OPTIONAL
  165.     } ,
  166.     maxlinks INTEGER ,             -- EntGetMaxLinks
  167.     eval CHOICE {                  -- EntTLEval
  168.       bad-count INTEGER ,             -- if too many UIDs to return set
  169.       link-set Link-set } ,
  170.     docsum CHOICE {                -- get summarys by term (DocSum)
  171.       ml Ml-summary-list ,         -- medline summary list
  172.       seq Seq-summary-list ,       -- sequence summary list
  173.       str Seq-summary-list } ,     -- biostruc summary list
  174.     linkuidlist Marked-link-set ,  -- LinkUidList
  175.     uidlinks Marked-link-set ,     -- UidLinks
  176.     byterm Entrez-term-resp ,      -- TermListByTerm
  177.     bypage Entrez-term-resp ,      -- TermListByPage
  178.     findterm Term-counts ,         -- EntrezFindTerm
  179.     fini NULL ,                    -- EntrezFini
  180.     createnamed NULL ,
  181.     getmle Entrez-Medline-entry-list ,   -- get Medline Entry
  182.     getseq Entrez-Seq-entry-list , -- get SeqEntry
  183.     evalX OCTET STRING ,           -- EntTLEvalX
  184.     createnamedX NULL ,
  185.     seqidforgi Seq-id ,            -- EntrezSeqIdForGI
  186.     findseqid INTEGER ,            -- EntrezFindSeqId
  187.     canneighbortext BOOLEAN ,         -- EntrezCanNeighborText 
  188.     expanded-medline BOOLEAN , 
  189.     get-hierarchy Entrez-Tree,
  190.     neighbortext Link-set ,
  191.     eval-count INTEGER ,            -- EntTLEvalCount
  192.     getbiostr Entrez-Biostruc-list ,-- EntrezBiostrucGet (obselete)
  193.     getbiostrX Entrez-Biostruc-list ,-- EntrezBiostrucGet
  194.     extrainfo Entrez-extra-info , 
  195.     blast CHOICE {                  -- BLAST
  196.       bad-count INTEGER ,             -- if too many UIDs to return set
  197.       link-set Link-set ,
  198.       job-start INTEGER ,
  199.       job-progress INTEGER } ,
  200.     docsumX New-summary-list ,
  201.     getgenome Entrez-Seq-entry-list } -- get genome
  202.  
  203. Entrez-extra-info ::= SEQUENCE {
  204.     maxlinks INTEGER ,
  205.     canneighbortext BOOLEAN ,
  206.     expanded-medline BOOLEAN ,
  207.     canblast BOOLEAN }
  208.  
  209. New-summary-list ::= SEQUENCE {          
  210.     num INTEGER ,
  211.     type Entrez-class ,
  212.     data SEQUENCE OF Docsum }
  213.  
  214. Ml-summary-list ::= SEQUENCE {
  215.     num INTEGER ,
  216.     data SEQUENCE OF Ml-summary }
  217.  
  218. Ml-summary ::= SEQUENCE {          
  219.     muid INTEGER ,
  220.     no-abstract BOOLEAN DEFAULT FALSE ,
  221.     translated-title BOOLEAN DEFAULT FALSE ,
  222.     no-authors BOOLEAN DEFAULT FALSE ,
  223.     caption VisibleString OPTIONAL ,
  224.     title VisibleString OPTIONAL }
  225.  
  226. Seq-summary-list ::= SEQUENCE {
  227.     num INTEGER ,
  228.     data SEQUENCE OF Seq-summary }
  229.  
  230. Seq-summary ::= SEQUENCE {
  231.     id INTEGER ,          -- Gi id
  232.     caption VisibleString OPTIONAL ,
  233.     title VisibleString OPTIONAL }
  234.  
  235. Marked-link-set ::= SEQUENCE {
  236.     link-set Link-set ,
  237.     uids-processed INTEGER ,
  238.     marked-missing Entrez-ids OPTIONAL }
  239.  
  240. Entrez-ids ::= SEQUENCE {
  241.     numid INTEGER ,                   -- number of ids to follow
  242.     ids SEQUENCE OF INTEGER }         -- the ids
  243.  
  244. Entrez-term-by-page ::= SEQUENCE {
  245.     type     Entrez-class ,           -- type of query
  246.     fld      Entrez-field ,           -- 
  247.     page     INTEGER ,                -- starting page number
  248.     num-pages INTEGER }               -- # of pages desired
  249.  
  250. Entrez-term-by-term ::= SEQUENCE {
  251.     type     Entrez-class ,           -- type of query
  252.     fld      Entrez-field ,           -- 
  253.     term     VisibleString ,          -- term on which to key
  254.     num-terms INTEGER }               -- # of terms desired
  255.  
  256. Term-lookup ::= SEQUENCE {
  257.     type     Entrez-class ,           -- type of query
  258.     fld      Entrez-field ,           -- 
  259.     term     VisibleString }
  260.  
  261. Term-page-info ::= SEQUENCE {
  262.     term       VisibleString ,
  263.     spec-count INTEGER ,
  264.     tot-count  INTEGER }
  265.  
  266. Term-counts ::= SEQUENCE {
  267.     found BOOLEAN ,                   -- was the term found ?
  268.     spec-count INTEGER ,
  269.     tot-count  INTEGER }
  270.  
  271. Entrez-term-resp ::= SEQUENCE {
  272.     num-terms INTEGER ,
  273.     first-page INTEGER OPTIONAL,
  274.     pages-read INTEGER ,
  275.     info SEQUENCE OF Term-page-info }
  276.  
  277. Entrez-named-list ::= SEQUENCE {
  278.     term       VisibleString ,
  279.     type       Entrez-class ,           -- type of query
  280.     fld        Entrez-field ,           -- 
  281.     uids       Entrez-ids }
  282.  
  283. Entrez-named-listX ::= SEQUENCE {
  284.     term       VisibleString ,
  285.     type       Entrez-class ,           -- type of query
  286.     fld        Entrez-field ,           -- 
  287.     uids       OCTET STRING }
  288.  
  289. Entrez-Seq-entry-list ::= SEQUENCE {
  290.     num INTEGER ,
  291.     data SEQUENCE OF Seq-entry ,
  292.     marked-missing Entrez-ids OPTIONAL }
  293.  
  294. Entrez-Medline-entry-list ::= SEQUENCE {
  295.     num INTEGER ,
  296.     data SEQUENCE OF Medline-entry ,
  297.     marked-missing Entrez-ids OPTIONAL }
  298.  
  299. Entrez-Biostruc-list ::= SEQUENCE {
  300.     num INTEGER ,
  301.     data SEQUENCE OF Biostruc ,
  302.     marked-missing Entrez-ids OPTIONAL }
  303.  
  304.  
  305. Entrez-Tree-Child ::= SEQUENCE {
  306.     name VisibleString ,
  307.     is-leaf-node BOOLEAN ,
  308.     special INTEGER ,
  309.     total INTEGER
  310. }
  311.  
  312. Entrez-Tree ::= SEQUENCE {
  313.     num-in-lineage INTEGER ,
  314.     num-children INTEGER ,
  315.     term VisibleString ,
  316.     lineage SEQUENCE OF VisibleString ,
  317.     children SEQUENCE OF Entrez-Tree-Child ,
  318.     canonical-form VisibleString OPTIONAL
  319. }
  320.  
  321. END
  322.